# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field do
  @moduledoc """
  Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all collections in the database with the same ID.

  ## Attributes

  *   `indexConfig` (*type:* `GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexConfig.t`, *default:* `nil`) - The index configuration for this field. If unset, field indexing will revert to the configuration defined by the `ancestor_field`. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.
  *   `name` (*type:* `String.t`, *default:* `nil`) - Required. A field name of the form: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path can be a simple field name, e.g. `address` or a path to fields within `map_value` , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths can be quoted using `` ` `` (backtick). The only character that must be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: `` `address.city` `` represents a field named `address.city`, not the map key `city` in the field `address`. `` `*` `` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.
  *   `ttlConfig` (*type:* `GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1TtlConfig.t`, *default:* `nil`) - The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :indexConfig =>
            GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexConfig.t() | nil,
          :name => String.t() | nil,
          :ttlConfig => GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1TtlConfig.t() | nil
        }

  field(:indexConfig, as: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexConfig)
  field(:name)
  field(:ttlConfig, as: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1TtlConfig)
end

defimpl Poison.Decoder, for: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field do
  def decode(value, options) do
    GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
